Introduction

This API provides endpoints for retrieving various types of monitor information, including details, instances, status, severity, and last poll information. It also offers performance metrics data based on widget IDs.

Call this API to obtain comprehensive details about each monitor.

📄️ Retrieve monitor status using Monitor ID

Call this API to obtain the status of each monitor by providing the Monitor ID.

📄️ Retrieve detailed information about instances using Monitor ID

Call this API to obtain detailed information for each monitor instance.

📄️ Retrieve Monitor Details by Filter

Call this API to get the details of monitors based on specific filters. The filter parameter must be provided in the query to filter and retrieve monitors that match the specified criteria.

📄️ Retrieve Monitor Details by Status

Call this API to get the details of monitors based on their status. The status parameter must be provided in the query to filter and retrieve the monitors that match the specified status.

📄️ Retrieve monitors with specific alert severity

Call this API to obtain a list of monitors that have alerts matching the severity level specified in the `severity` parameter.

📄️ Retrieve the Last Poll Information for a Monitor

Call this API to obtain the last poll information for a specific monitor, including details about the metric group. The Monitor ID must be provided to fetch the corresponding poll information.

📄️ Retrieve monitors from group

Call this API to obtain the monitors within a group via the corresponding Group ID.

📄️ Retrieve all performance metrics dashboards.

This endpoint retrieves all available dashboards containing performance metrics details. The data returned includes information such as dashboard IDs, names, category, and their configurations.

📄️ Retrieve Widgets from a Specific Dashboard

This endpoint retrieves all widgets associated with a specific dashboard, identified by its unique dashboard ID. The response includes the widget IDs and details of each widget within the dashboard, allowing for subsequent metric retrieval operations on individual widgets.

📄️ Retrieve details of a specific widget like widget name by its ID.

This endpoint retrieves detailed information about a specific widget using its unique ID. The widget details include widget name, description, category, widget timeline details and other relevant data that can be used to identify the widget. This endpoint is useful for users who need to identify the widget for further performance metrics retrieval from the widget.

📄️ Retrieve Performance Metrics Information Based on Widget ID

Call this API to retrieve the Key Performance Indicators (KPIs) for a specific widget. The `id` parameter must be provided to specify the widget of a dashboard for which you want to retrieve the KPIs.

📄️ Retrieve historical time-series data for a single metric

This endpoint retrieves time-series data for a single specified metric over a given timeline. The data is displayed as a series of data points, each representing a specific moment in time. Users can specify a metric (e.g., `system.cpu.percent`), the entity type (e.g., `monitor`), and a list of specific entities. The data can be aggregated using methods such as `avg` (average) or others based on the user's request. Additionally, the timeline and granularity can be customized, allowing for detailed insights into both current and historical performance metrics.

📄️ Retrieve aggregated metric data for multiple counters

This endpoint retrieves aggregated historical data for multiple specified metrics over a given timeline. The data is aggregated using methods such as `avg` (average), `sum`, `min`, `max`, or `count`, based on the user's request. Users can specify multiple data points (e.g., `system.cpu.percent`, `system.memory.used.percent`) along with the entity type (e.g., `monitor`) and a list of specific entities. Additionally, the timeline for the data can be customized, allowing users to fetch both current and historical data. Unlike the histogram API, this endpoint returns aggregated values rather than time series data, providing a summary view of the metrics based on the selected parameters.